Pular para o conteúdo principal

2.2.1. Cartão INSS

Na modalidade Cartão Benefício INSS, é realizada a formalização de uma operação de crédito rotativo vinculada ao benefício previdenciário do cliente. O limite do cartão é definido com base na margem consignável disponível, permitindo compras e saques com desconto automático na folha de pagamento do benefício.

Códigos dos Provedores​

Os Códigos dos Provedores são utilizados para identificar e rotear as suas operações para a instituição financeira correta.

Você deve informar o código correspondente ao banco desejado no momento de realizar simulações ou cadastrar propostas. Isso garante que a transação seja processada exatamente com as regras, políticas de crédito e taxas daquele provedor específico.

ProvedorCódigo
QITech950005

Autenticação​

Para realizar requisições aos nossos endpoints, é necessário utilizar uma API Key válida. Esta chave é o identificador que garante a segurança e o controle de acesso às operações da plataforma.

KeyValue
apikey{{apikey}}
aviso

Importante: Mantenha sua API Key em segurança. Ela é pessoal, intransferível e dá acesso direto às operações de crédito e dados de clientes da sua conta.

POST Listar Tabelas por tipo de operação​

/v3/loan-product-rules/search/basic

Este endpoint permite listar as tabelas de regras disponíveis para cartão benefício filtrando por tipo de operação.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
offsetnumberSimÍndice inicial para paginação
limitnumberSimQuantidade máxima de registros retornados (Máximo de 20 por página)
operation.code.eqnumberSimCódigo da operação desejada

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "offset": 0,
    "limit": 0,
    "operation": {
        "code": {
            "eq": 3
        }
    }
}

POST Calculadora de Cartão INSS​

/v3/loan-inss-card-simulations/950005/calculation-item

Este endpoint permite calcular os valores de um cartão benefício INSS antes de criar a simulação.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
ruleIdstring (UUID)SimID da tabela de produto
hasInsurancebooleanSimtrue para incluir seguro, false para remover
installmentValuenumberSimValor da parcela desejada
loanValuenumberSimValor do limite do cartão
ratenumberSimTaxa de juros mensal
termnumberSimPrazo em meses
referenceCodestring | nullNãoCódigo de referência externo
Atenção ao preenchimento do benefitValue

O campo benefitValue é reservado exclusivamente para o valor correspondente aos 5% da margem disponível.

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "id": "b81ade7f-928a-4e48-89b1-4dd71d0dd767",
    "type": 2,
    "identity": "13329716010",
    "benefit": "4562356142",
    "ruleId": "1647a836-f142-495b-ad47-10f052882068",
    "term": 96,
    "rate": 1.85,
    "benefitValue": "300.00",
    "additionalValue": 0,
    "hasInsurance": false
}

POST Criar uma nova simulação de Cartão INSS​

/v3/loan-inss-card-simulations/providers/950005

Este endpoint permite criar uma simulação de cartão benefício INSS.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
borrower.namestringSimNome completo do tomador
borrower.identitystringSimCPF do tomador
borrower.benefitstringSimNúmero do benefício INSS
borrower.benefitStatestringSimUF do benefício
borrower.benefitStartDatestring (ISO 8601)SimData de início do benefício
borrower.benefitTypenumberSimCódigo do tipo de benefício
borrower.birthDatestring (ISO 8601)SimData de nascimento
borrower.incomenumberSimRenda mensal do tomador
borrower.phonestringSimTelefone com DDD
borrower.emailstringSimE-mail do tomador
borrower.addressobjectSimEndereço completo
borrower.documentobjectSimDocumento de identificação
items[].ruleIdstring (UUID)SimID da tabela de produto
items[].hasInsurancebooleanSimIndica se há seguro
items[].installmentValuenumberSimValor da parcela
items[].loanValuenumberSimValor do limite do cartão
items[].ratenumberSimTaxa de juros mensal
items[].termnumberSimPrazo em meses
creditBankAccountobjectSimDados bancários para crédito
filesarraySimDocumentos anexados (doc_front, doc_back)
step.codenumberSimEtapa atual da proposta

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "borrower": {
        "name": "IVOLANDO MIRANDA",
        "identity": "13329716010",
        "benefit": "4562356142",
        "birthDate": "1961-02-07T03:00:00.000Z",
        "motherName": null,
        "maritalStatus": null,
        "sex": null,
        "income": null,
        "marginValue": null,
        "phone": "11924611448",
        "email": null,
        "address": {
            "id": "4dbdbad7-765c-4e38-a008-c72cc9381c81",
            "prefix": null,
            "street": null,
            "number": null,
            "complement": null,
            "district": null,
            "city": null,
            "state": null,
            "country": null,
            "zipCode": null
        },
        "document": {
            "type": {
                "code": "rg",
                "name": "RG"
            },
            "number": null,
            "issuingDate": null,
            "issuingEntity": null,
            "issuingState": null
        },
        "benefitState": "",
        "benefitStartDate": null,
        "benefitType": 0,
        "benefitPaymentMethod": 0,
        "hasLegalRepresentative": false,
        "legalRepresentative": {
            "name": null,
            "identity": null,
            "birthDate": null,
            "nickname": null,
            "motherName": null,
            "address": {
                "id": "4dbdbad7-765c-4e38-a008-c72cc9381c81",
                "prefix": null,
                "street": null,
                "number": null,
                "complement": null,
                "district": null,
                "city": null,
                "state": null,
                "country": null,
                "zipCode": null
            },
            "phone": "11924611448",
            "email": null
        }
    },
    "items": [],
    "creditBankAccount": {
        "type": 0
    },
    "itemId": null,
    "files": [],
    "step": {
        "code": 0,
        "name": "Consulta IN100"
    },
    "note": null
}

GET Obter termo de autorização​

/v3/loan-inss-simulations/{{simulation_id}}/auth-term

Este endpoint retorna o termo de autorização para consulta do benefício INSS. O campo key retornado deve ser utilizado no próximo passo para assinatura do termo.

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location 'https://integration.ajin.io/v3/loan-inss-simulations/{{simulation_id}}/auth-term' \
--header 'apikey: {{apikey}}'

PUT Assinar termo de autorização​

/v3/signer/{{auth_term_key}}/accept

Este endpoint realiza a assinatura do termo de autorização. Atenção: só deve ser executado se status.key != 'signed' no response do endpoint anterior.

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "position": {
        "latitude": "-235489",
        "longitude": "-466388"
    }
}

POST Gerar Contratos de Empréstimo​

/v3/loan-inss-simulations/{{simulation_id}}/actions

Este endpoint é responsável por transformar uma simulação aprovada em contratos efetivos, iniciando o processo de formalização e assinatura do cartão benefício.

Exemplo de Requisição e Resposta​

Visualizar Body
{
  "command": "create_loans"
}

GET Consultar Contratos de Empréstimo pelo ID da Simulação​

/v3/loans/simulation/{{simulation_id}}

Este endpoint permite consultar todos os contratos de cartão benefício vinculados a uma simulação específica.

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location 'https://integration.ajin.io/v3/loans/simulation/{{simulation_id}}' \
--header 'apikey: {{apikey}}'